<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Dwoo_Filter_html_format</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Dwoo_Filter_html_format</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats any html output (must be valid xml where every tag opened is closed)  using a single tab for indenting. 'pre' and other whitespace sensitive  tags should not be affected.</p>
<p class="description"><p>It is not recommended to use this on every template if you render multiple  templates per page, you should only use it once on the main page template so that  everything is formatted in one pass.</p><p>This software is provided 'as-is', without any express or implied warranty.  In no event will the authors be held liable for any damages arising from the use of this software.</p><p>This file is released under the LGPL  &quot;GNU Lesser General Public License&quot;  More information can be found here:  <a href="http://www.gnu.org/copyleft/lesser.html">http://www.gnu.org/copyleft/lesser.html</a></p></p>
	<ul class="tags">
				<li><span class="field">author:</span> Jordi Boggiano &lt;<a href="mailto:j.boggiano@seld.be">j.boggiano@seld.be</a>&gt;</li>
				<li><span class="field">version:</span> 0.9.1</li>
				<li><span class="field">copyright:</span> Copyright (c) 2008, Jordi Boggiano</li>
				<li><span class="field">link:</span> <a href="http://dwoo.org/">http://dwoo.org/</a></li>
				<li><span class="field">date:</span> 2008-05-30</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/copyleft/lesser.html">GNU Lesser General Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_plugins---builtin---filters---html_format.php.html">/plugins/builtin/filters/html_format.php</a> (line <span class="field"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a28">28</a></span>)
		</p>
		
				
		<pre><a href="../Dwoo/Dwoo_Filter.html">Dwoo_Filter</a>
   |
   --Dwoo_Filter_html_format</pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
												<div class="var-title">
					static <span class="var-type">string</span>
					<a href="#$lastCallAdd" title="details" class="var-name">$lastCallAdd</a>
				</div>
																<div class="var-title">
					static <span class="var-type">int</span>
					<a href="#$tabCount" title="details" class="var-name">$tabCount</a>
				</div>
																															</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
										
				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#closeTag" title="details" class="method-name">closeTag</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$whitespace</span>)
									</div>
														
				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#openTag" title="details" class="method-name">openTag</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$whitespace</span>)
									</div>
																						
				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#singleTag" title="details" class="method-name">singleTag</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$whitespace</span>)
									</div>
														
				<div class="method-definition">
					static 						<span class="method-result">string</span>
										<a href="#tagDispatcher" title="details" class="method-name">tagDispatcher</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$input</span>)
									</div>
																																		
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#process" title="details" class="method-name">process</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$input</span>, <span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
									</div>
																											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$lastCallAdd" id="$lastCallAdd"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">string</span>
			<span class="var-name">$lastCallAdd</span>
			 = <span class="var-default"> ''</span>			(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a42">42</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">stores the additional data (following a tag) of the last call to open/close/singleTag</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$tabCount" id="$tabCount"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">int</span>
			<span class="var-name">$tabCount</span>
			 = <span class="var-default"> -1</span>			(line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a35">35</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">tab count to auto-indent the source</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>

							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../Dwoo/Dwoo_Filter.html">Dwoo_Filter</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../Dwoo/Dwoo_Filter.html#var$dwoo">Dwoo_Filter::$dwoo</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="methodcloseTag" id="closeTag"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static closeTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a135">135</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns a closing tag and removes a tab from the auto indenting</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			closeTag
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$whitespace</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$tag</span><span class="var-description">: content of the tag</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$add</span><span class="var-description">: additional data (anything before the following tag)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$whitespace</span><span class="var-description">: white space between the tag and the additional data</span>			</li>
				</ul>
		
			
	</div>
<a name="methodopenTag" id="openTag"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static openTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a97">97</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns an open tag and adds a tab into the auto indenting</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			openTag
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$whitespace</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$tag</span><span class="var-description">: content of the tag</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$add</span><span class="var-description">: additional data (anything before the following tag)</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$whitespace</span><span class="var-description">: white space between the tag and the additional data</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsingleTag" id="singleTag"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static singleTag</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a166">166</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">returns a single tag with auto indenting</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			singleTag
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$tag</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$add</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$whitespace</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$tag</span><span class="var-description">: content of the tag</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$add</span><span class="var-description">: additional data (anything before the following tag)</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$whitespace</span>			</li>
				</ul>
		
			
	</div>
<a name="methodtagDispatcher" id="tagDispatcher"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static tagDispatcher</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a71">71</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">helper function for format()'s preg_replace call</p>
	<ul class="tags">
				<li><span class="field">return:</span> the indented tag</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		static <span class="method-result">string</span>
		<span class="method-name">
			tagDispatcher
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$input</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$input</span><span class="var-description">: array of matches (1=&gt;tag, 2=&gt;whitespace(optional), 3=&gt;additional non-html content)</span>			</li>
				</ul>
		
			
	</div>
<a name="methodprocess" id="process"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">process</span> (line <span class="line-number"><a href="../__filesource/fsource_Dwoo__pluginsbuiltinfiltershtml_format.php.html#a55">55</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">formats the input using the singleTag/closeTag/openTag functions</p>
<p class="description"><p>It is auto indenting the whole code, excluding &lt;textarea&gt;,</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> formatted xhtml</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			process
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$input</span>, <span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>&nbsp;<span class="var-name">$dwoo</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../Dwoo/Dwoo.html">Dwoo</a></span>
				<span class="var-name">$dwoo</span><span class="var-description">: the dwoo instance rendering this</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$input</span><span class="var-description">: the xhtml to format</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../Dwoo/Dwoo_Filter.html#methodprocess">Dwoo_Filter::process()</a></dt>
						<dd>processes the input and returns it filtered</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../Dwoo/Dwoo_Filter.html">Dwoo_Filter</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../Dwoo/Dwoo_Filter.html#method__construct">Dwoo_Filter::__construct()</a></span><br>
													<span class="method-name"><a href="../Dwoo/Dwoo_Filter.html#methodprocess">Dwoo_Filter::process()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 30 May 2008 04:51:41 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>